Platform Explorer / Nuxeo Platform 2023.14

Operation Document.CheckIn (Check In)

Description

Checks in the input document. Returns back the document.
Operation id Document.CheckIn
Category Document
Label Check In
Requires
Since

Parameters

Name Description Type Required Default value
version string yes none, minor, major 
comment string no  
versionVarName string no  

Signature

Inputs document, documents
Outputs document, documents

Implementation Information

Implementation Class Class: org.nuxeo.ecm.automation.core.operations.document.CheckInDocument
Contributing Component org.nuxeo.ecm.core.automation.coreContrib

JSON Definition

{
  "id" : "Document.CheckIn",
  "label" : "Check In",
  "category" : "Document",
  "requires" : null,
  "description" : "Checks in the input document. Returns back the document.",
  "url" : "Document.CheckIn",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "version",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ "none", "minor", "major" ]
  }, {
    "name" : "comment",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 1,
    "values" : [ ]
  }, {
    "name" : "versionVarName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 2,
    "values" : [ ]
  } ]
}